版本管理
# 列出版本
请求
GET /openapi/delivery/releases?projectKey=<projectKey>&pageNum=<pageNum>&pageSize=<pageSize>
1
Query 参数说明
| 参数名 | 类型 | 描述 | 必填 |
|---|---|---|---|
projectKey | string | 项目标识 | 是 |
pageNum | int | 指定页数 | 是 |
pageSize | int | 每页数量 | 是 |
成功返回说明
| 参数名 | 类型 | 描述 |
|---|---|---|
list | []DeliveryVersionInfo | 版本列表 |
total | int | 版本总数 |
DeliveryVersionInfo 参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
id | string | 版本ID |
version_name | string | 版本名称 |
type | string | 类型，K8SYaml 或 HelmChart |
status | string | 状态，success、failed、creating、retrying |
labels | []string | 标签 |
description | string | 描述 |
progress | DeliveryVersionProgress | 进度，仅在获取版本详情接口中返回该数据 |
created_by | string | 创建人 |
created_time | int64 | 创建时间 |
DeliveryVersionProgress 参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
success_count | int | 成功数量 |
total_count | int | 总数 |
upload_status | string | 上传状态，success、failed、waiting、uploading |
error | string | 错误信息 |
成功返回示例
点击查看
{
"list": [
{
"id": "66287b110b8b8a631910f5ae",
"version_name": "v13",
"type": "K8SYaml",
"status": "success",
"labels": [],
"description": "labore id amet",
"progress": null,
"created_by": "patrick",
"create_time": 1713928977
},
{
"id": "662751047ac26dae6a3a1472",
"version_name": "v12",
"type": "K8SYaml",
"status": "failed",
"labels": [],
"description": "labore id amet",
"progress": null,
"created_by": "patrick",
"create_time": 1713852676
}
],
"total": 12
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
# 获取版本详情
请求
GET /openapi/delivery/releases/:id
1
路径参数说明
| 参数名 | 类型 | 描述 | 必填 |
|---|---|---|---|
id | string | 版本ID | 是 |
成功返回说明
| 参数名 | 说类型明 | |
|---|---|---|
version_info | DeliveryVersionInfo | 版本详情 |
deploy_infos | []DeliveryDeployInfo | K8s 交付物详情，仅当 type 为 K8SYaml 时使用 |
distribute_infos | []DeliveryDistributeInfo | Helm 交付物详情，仅当 type 为 HelmChart 时使用 |
DeliveryDeployInfo 参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
id | string | K8s 交付物 ID |
service_name | string | 服务名称 |
service_module | string | 服务组件名称 |
image | string | 完整镜像地址 |
image_name | string | 镜像名称 |
registry_id | string | 镜像仓库 ID |
created_time | int64 | 创建时间 |
DeliveryDistributeInfo 参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
id | string | Helm 交付物 ID |
service_name | string | 服务名称 |
distribute_type | string | 交付物类型，chart 或 image |
chart_name | string | Chart 名称，仅当 distribute_type 为 chart 时使用 |
chart_repo_name | string | Chart 仓库名称，仅当 distribute_type 为 chart 时使用 |
chart_version | string | Chart 版本，仅当 distribute_type 为 chart 时使用 |
service_module | string | 服务组件名称，仅当 distribute_type 为 image 时使用 |
image | string | 完整镜像地址，仅当 distribute_type 为 image 时使用 |
image_name | string | 镜像名称，仅当 distribute_type 为 image 时使用 |
namespace | string | 镜像仓库 namespace，仅当 distribute_type 为 image 时使用 |
created_time | int64 | 创建时间 |
sub_distributes | DeliveryDistributeInfo | 子交付物，通常只嵌套一层，父交付物为 chart 类型，子交付物为 image 类型 |
成功返回示例
K8s YAML 项目
点击查看
{
"version_info": {
"id": "66287b110b8b8a631910f5ae",
"version_name": "v13",
"type": "K8SYaml",
"status": "success",
"labels": [
"cupidatat ullamco anim eiusmod"
],
"description": "labore id amet",
"progress": {
"success_count": 2,
"total_count": 2,
"upload_status": "success",
"error": ""
},
"created_by": "patrick",
"create_time": 1713928977
},
"deploy_infos": [
{
"id": "66287b110b8b8a631910f5af",
"service_name": "service1",
"service_module": "service1",
"image": "koderover.tencentcloudcr.com/test/service1:20240419133934-5-main",
"image_name": "service1",
"registry_id": "62ce6231e0281143de477e60",
"create_time": 1713928977
},
{
"id": "66287b110b8b8a631910f5b0",
"service_name": "service2",
"service_module": "service2",
"image": "koderover.tencentcloudcr.com/test/service2:20240419133934-5-main",
"image_name": "service2",
"registry_id": "62ce6231e0281143de477e60",
"create_time": 1713928977
}
],
"distribute_infos": []
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
Helm Chart 项目
点击查看
{
"version_info": {
"id": "66287c000b8b8a631910f5b8",
"version_name": "v4",
"type": "HelmChart",
"status": "success",
"labels": [
"cupidatat ullamco anim eiusmod"
],
"description": "labore id amet",
"progress": {
"success_count": 2,
"total_count": 2,
"upload_status": "success",
"error": ""
},
"created_by": "patrick",
"create_time": 1713929216
},
"deploy_infos": [],
"distribute_infos": [
{
"id": "66287c080b8b8a631910f5bd",
"service_name": "service2",
"distribute_type": "chart",
"chart_name": "service2",
"chart_repo_name": "test",
"chart_version": "1.76",
"service_module": "",
"image": "",
"image_name": "",
"namespace": "",
"create_time": 1713929224,
"sub_distributes": [
{
"id": "66287c080b8b8a631910f5bc",
"service_name": "service2",
"distribute_type": "image",
"chart_name": "",
"chart_repo_name": "",
"chart_version": "",
"service_module": "service2",
"image": "koderover.tencentcloudcr.com/test/service2:20240419133934-5-main",
"image_name": "service2",
"namespace": "test",
"create_time": 1713929224,
"sub_distributes": []
}
]
},
{
"id": "66287c0f0b8b8a631910f5c0",
"service_name": "service1",
"distribute_type": "chart",
"chart_name": "service1",
"chart_repo_name": "test",
"chart_version": "1.76",
"service_module": "",
"image": "",
"image_name": "",
"namespace": "",
"create_time": 1713929231,
"sub_distributes": [
{
"id": "66287c0f0b8b8a631910f5bf",
"service_name": "service1",
"distribute_type": "image",
"chart_name": "",
"chart_repo_name": "",
"chart_version": "",
"service_module": "service1",
"image": "koderover.tencentcloudcr.com/test/service1:20240419133934-5-main",
"image_name": "service1",
"namespace": "test",
"create_time": 1713929231,
"sub_distributes": []
}
]
}
]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
# 删除版本
请求
DELETE /openapi/delivery/releases/:id?projectKey=<projectKey>
1
路径参数说明
| 参数名 | 类型 | 描述 | 必填 |
|---|---|---|---|
id | string | 版本ID | 是 |
Query 参数说明
| 参数名 | 类型 | 描述 | 必填 |
|---|---|---|---|
projectKey | string | 项目标识 | 是 |
成功返回示例
{
"message": "success"
}
1
2
3
2
3
# K8s YAML 项目创建版本
请求
POST /openapi/delivery/releases/k8s
1
body 参数说明
| 参数名 | 类型 | 描述 |
|---|---|---|
project_key | string | 项目标识 |
version_name | string | 版本名称 |
retry | bool | 是否为重试 |
env_name | string | 环境名称 |
production | bool | 是否为生产环境 |
desc | string | 描述 |
labels | []string | 标签 |
image_registry_id | string | 镜像仓库 ID |
yaml_datas | []DeliveryVersionYamlData | Yaml 服务数据列表 |
DeliveryVersionYamlData 参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
service_name | string | 服务名称 |
image_datas | []DeliveryVersionImageData | ReTag 镜像数据列表 |
DeliveryVersionImageData 参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
container_name | string | 容器名称 |
image_name | string | 镜像名称 |
image_tag | string | 镜像 tag |
disable_image_dist | bool | 是否禁用镜像分发 |
成功返回示例
{
"message": "success"
}
1
2
3
2
3
# Helm Chart 项目创建版本
请求
POST /openapi/delivery/releases/helm
1
body 参数说明
| 参数名 | 类型 | 描述 |
|---|---|---|
project_key | string | 项目标识 |
version_name | string | 版本名称 |
retry | bool | 是否为重试 |
env_name | string | 环境名称 |
production | bool | 是否为生产环境 |
desc | string | 描述 |
labels | []string | 标签 |
image_registry_id | string | 镜像仓库 ID |
chart_repo_name | string | Chart 仓库名称 |
chart_datas | []DeliveryVersionChartData | Chart 服务数据列表 |
DeliveryVersionChartData 参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
service_name | string | 服务名称 |
version | string | Chart 版本号 |
image_datas | []DeliveryVersionImageData | ReTag 镜像数据列表 |
成功返回示例
{
"message": "success"
}
1
2
3
2
3
